normalize-path

What is normalize-path?

The normalize-path npm package is designed to normalize file paths, making them consistent across different operating systems and environments. It can be particularly useful for handling file paths in a cross-platform manner, ensuring that paths are correctly formatted and can be reliably compared or manipulated regardless of the underlying OS.

What are normalize-path's main functionalities?

Normalize slashes

Converts Windows backslash paths to POSIX forward slashes, making paths consistent across different environments.

"const normalize = require('normalize-path');
console.log(normalize('C:\\path\\to\\file')); // 'C:/path/to/file'"

Remove trailing slashes

Optionally removes trailing slashes from paths, which can be useful for comparing directory paths or constructing URLs.

"const normalize = require('normalize-path');
console.log(normalize('path/to/resource/', false)); // 'path/to/resource'"

Normalize for use in URLs

Cleans up the path by resolving dot segments (e.g., '..' and '.') to produce a canonical path. This is particularly useful for creating clean URLs.

"const normalize = require('normalize-path');
console.log(normalize('/foo/bar//baz/asdf/quux/..')); // '/foo/bar/baz/asdf'"

Other packages similar to normalize-path

path

The 'path' module is a core Node.js module that provides utilities for working with file and directory paths. It offers similar normalization functionalities but is built into Node.js, meaning it doesn't require an additional installation. Unlike normalize-path, it handles paths differently based on the operating system.

upath

upath is an extension of Node.js's path module that normalizes paths to always use forward slashes, similar to normalize-path. It also adds filename and extension manipulation functions. upath provides a broader set of path manipulation utilities while maintaining cross-platform consistency.

README

normalize-path

Normalize file path slashes to be unix-like forward slashes. Also condenses repeat slashes to a single slash and removes and trailing slashes unless disabled.

Install

Install with npm:

$ npm install --save normalize-path

Usage

var normalize = require('normalize-path');

normalize('\\foo\\bar\\baz\\');
//=> '/foo/bar/baz'

normalize('./foo/bar/baz/');
//=> './foo/bar/baz'

Pass false as the last argument to keep trailing slashes:

normalize('./foo/bar/baz/', false);
//=> './foo/bar/baz/'

normalize('foo\\bar\\baz\\', false);
//=> 'foo/bar/baz/'

About

Related projects

• contains-path: Return true if a file path contains the given path. | homepage
• ends-with: Returns true if the given string or array ends with suffix using strict equality for… more | homepage
• is-absolute: Polyfill for node.js path.isAbolute. Returns true if a file path is absolute. | homepage
• is-relative: Returns true if the path appears to be relative. | homepage
• parse-filepath: Pollyfill for node.js path.parse, parses a filepath into an object. | homepage
• path-ends-with: Return true if a file path ends with the given string/suffix. | homepage
• path-segments: Get n specific segments of a file path, e.g. first 2, last 3, etc. | homepage
• rewrite-ext: Automatically re-write the destination extension of a filepath based on the source extension. e.g… more | homepage
• unixify: Convert Windows file paths to unix paths. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits	Contributor
31	jonschlinkert
1	phated

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.4.3, on March 29, 2017.